/**
 * This class represents the possible color representations.
 */
package org.hackystat.ui.orb.client.common;

import java.util.Map;

/**
 * This class represents the possible color representations.
 * @author David J. Nickles
 *
 */
public class ColorsEnum extends Enum {
  
  /**
   * Required no parameter constructor.
   */
  public ColorsEnum() { 
    super();
  }

  /**
   * Name and cardinal pair.
   * @param name the color name.
   * @param ordinal the color value.
   */
  private ColorsEnum(String name, int ordinal) {
    super(name, ordinal);
  }

  /** {@literal} RED color. */    
  public static /* final */ ColorsEnum RED = new ColorsEnum("RED", 0);
  /** {@literal} SCARLET color. */   
  public static /* final */ ColorsEnum SCARLET = new ColorsEnum("SCARLET", 1);
  /** {@literal} TANGERINE color. */        
  public static /* final */ ColorsEnum TANGERINE = new ColorsEnum("TANGERINE", 2); 
  /** {@literal} ORANGE color. */        
  public static /* final */ ColorsEnum ORANGE = new ColorsEnum("ORANGE", 3); 
  /** {@literal} AMBER color. */        
  public static /* final */ ColorsEnum AMBER = new ColorsEnum("AMBER", 4); 
  /** {@literal} GOLD color. */        
  public static /* final */ ColorsEnum GOLD = new ColorsEnum("GOLD", 5); 
  /** {@literal} YELLOW color. */        
  public static /* final */ ColorsEnum YELLOW = new ColorsEnum("YELLOW", 6); 
  /** {@literal} TURBO color. */        
  public static /* final */ ColorsEnum TURBO = new ColorsEnum("TURBO", 7); 
  /** {@literal} CHARTREUSE color. */        
  public static /* final */ ColorsEnum CHARTREUSE = new ColorsEnum("CHARTREUSE", 8); 
  /** {@literal} LIME color. */        
  public static /* final */ ColorsEnum LIME = new ColorsEnum("LIME", 9); 
  /** {@literal} BRIGHTGREEN color. */        
  public static /* final */ ColorsEnum BRIGHTGREEN = new ColorsEnum("BRIGHTGREEN", 10); 
  /** {@literal} HARLEQUIN color. */        
  public static /* final */ ColorsEnum HARLEQUIN = new ColorsEnum("HARLEQUIN", 11); 
  /** {@literal} GREEN color. */        
  public static /* final */ ColorsEnum GREEN = new ColorsEnum("GREEN", 12); 
  /** {@literal} MALACHITE color. */        
  public static /* final */ ColorsEnum MALACHITE = new ColorsEnum("MALACHITE", 13); 
  /** {@literal} SPRINGGREEN color. */        
  public static /* final */ ColorsEnum SPRINGGREEN = new ColorsEnum("SPRINGGREEN", 14); 
  /** {@literal} BRIGHTTURQUOISE color. */        
  public static /* final */ ColorsEnum BRIGHTTURQUOISE = new ColorsEnum("BRIGHTTURQUOISE", 15); 
  /** {@literal} AQUA color. */        
  public static /* final */ ColorsEnum AQUA = new ColorsEnum("AQUA", 16); 
  /** {@literal} TURQUOISE color. */        
  public static /* final */ ColorsEnum TURQUOISE = new ColorsEnum("TURQUOISE", 17); 
  /** {@literal} CERULEAN color. */        
  public static /* final */ ColorsEnum CERULEAN = new ColorsEnum("CERULEAN", 18); 
  /** {@literal} AZURE color. */        
  public static /* final */ ColorsEnum AZURE = new ColorsEnum("AZURE", 19); 
  /** {@literal} BLUERIBBON color. */        
  public static /* final */ ColorsEnum BLUERIBBON = new ColorsEnum("BLUERIBBON", 20); 
  /** {@literal} BLUE color. */        
  public static /* final */ ColorsEnum BLUE = new ColorsEnum("BLUE", 21); 
  /** {@literal} ELECTRICVIOLET color. */        
  public static /* final */ ColorsEnum ELECTRICVIOLET = new ColorsEnum("ELECTRICVIOLET", 22); 
  /** {@literal} LUCKYPOINT color. */        
  public static /* final */ ColorsEnum LUCKYPOINT = new ColorsEnum("LUCKYPOINT", 23); 
  /** {@literal} INDIGO color. */        
  public static /* final */ ColorsEnum INDIGO = new ColorsEnum("INDIGO", 24); 
  /** {@literal} HONEYFLOWER color. */        
  public static /* final */ ColorsEnum HONEYFLOWER = new ColorsEnum("HONEYFLOWER", 25); 
  /** {@literal} METEORITE color. */        
  public static /* final */ ColorsEnum METEORITE = new ColorsEnum("METEORITE", 26); 
  /** {@literal} MAGENTA color. */        
  public static /* final */ ColorsEnum MAGENTA = new ColorsEnum("MAGENTA", 27); 
  /** {@literal} SEANCE color. */        
  public static /* final */ ColorsEnum SEANCE = new ColorsEnum("SEANCE", 28); 
  /** {@literal} DISCO color. */        
  public static /* final */ ColorsEnum DISCO = new ColorsEnum("DISCO", 29); 
  /** {@literal} VIOLET color. */        
  public static /* final */ ColorsEnum VIOLET = new ColorsEnum("VIOLET", 30); 
  /** {@literal} PURPLEPIZZAZZ color. */        
  public static /* final */ ColorsEnum PURPLEPIZZAZZ = new ColorsEnum("PURPLEPIZZAZZ", 31); 
  /** {@literal} CERISE color. */        
  public static /* final */ ColorsEnum CERISE = new ColorsEnum("CERISE", 32); 
  /** {@literal} ROSE color. */        
  public static /* final */ ColorsEnum ROSE = new ColorsEnum("ROSE", 33); 
  /** {@literal} REDRIBBON color. */        
  public static /* final */ ColorsEnum REDRIBBON = new ColorsEnum("REDRIBBON", 34); 
  /** {@literal} TORCH color. */        
  public static /* final */ ColorsEnum TORCH = new ColorsEnum("TORCH", 35); 
  /** {@literal} WHITE color. */        
  public static /* final */ ColorsEnum WHITE = new ColorsEnum("WHITE", 36); 

  /** {@literal} The collection of possible colors represented by this enumeration. */        
  private static /* final */ Map values =
    makeValuesMap(new Enum[] { RED, SCARLET, TANGERINE, ORANGE, AMBER, GOLD, YELLOW, TURBO, 
      CHARTREUSE, LIME, BRIGHTGREEN, HARLEQUIN, GREEN, MALACHITE, SPRINGGREEN, BRIGHTTURQUOISE,
      AQUA, TURQUOISE, CERULEAN, AZURE, BLUERIBBON, BLUE, ELECTRICVIOLET, LUCKYPOINT, INDIGO,
      HONEYFLOWER, METEORITE, MAGENTA, SEANCE, DISCO, VIOLET, PURPLEPIZZAZZ, CERISE, ROSE, 
      REDRIBBON, TORCH, WHITE });

  /**
   * Exchanges a name for an enumerated value.
   * @param name the color name.
   * @return the enumerated value.
   */
  public static ColorsEnum valueOf(String name) {
    return (ColorsEnum)values.get(name);
  }
  
  /**
   * This method generates an array containing all the enumerated colors.
   * @return an array containing all the enumerated colors.
   */
  public static ColorsEnum[] toArray() {
    return (ColorsEnum[])values.values().toArray(new ColorsEnum[0]);
  }
}
